package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.CompanyContractQuotaAddDTO;
import org.jsola.hr.dto.CompanyContractQuotaUpdateDTO;
import org.jsola.hr.query.CompanyContractQuotaQuery;
import org.jsola.hr.vo.CompanyContractQuotaVO;

import java.util.List;

/**
 * 公司合同配额表
 *
 * @author wcl
 */
@Api(tags = "hr-公司合同配额表")
public interface ICompanyContractQuotaControllerAPI {

    /**
     * 新增公司合同配额
     *
     * @param companyContractQuotaAddDTO 公司合同配额新增实体
     * @return 公司合同配额展示对象
     */
    @ApiOperation(value = "新增公司合同配额")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyContractQuotaAddDTO", dataType = "CompanyContractQuotaAddDTO", value = "新增公司合同配额", paramType = "body")
    })
    Result<CompanyContractQuotaVO> save(CompanyContractQuotaAddDTO companyContractQuotaAddDTO);


    /**
     * 修改公司合同配额
     *
     * @param companyContractQuotaUpdateDTO 公司合同配额
     * @return 更新数量
     */
    @ApiOperation(value = "修改公司合同配额")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyContractQuotaUpdateDTO", dataType = "CompanyContractQuotaUpdateDTO", value = "修改公司合同配额", paramType = "body")
    })
    Result<Integer> update(CompanyContractQuotaUpdateDTO companyContractQuotaUpdateDTO);

    /**
     * 删除单个公司合同配额，彻底删除
     *
     * @param companyContractQuotaId 公司合同配额id
     * @return 删除数量
     */
    @ApiOperation(value = "删除单个公司合同配额，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyContractQuotaId", dataType = "Long", value = "公司合同配额id", paramType = "path")
    })
    Result<Integer> delete(Long companyContractQuotaId);


    /**
     * 批量删除公司合同配额，彻底删除
     *
     * @param companyContractQuotaIds 公司合同配额id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除公司合同配额，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyContractQuotaIds", dataType = "Long[]", value = "公司合同配额id数组", paramType = "body", allowMultiple = true)
    })
    Result<Integer> deleteBatch(Long[] companyContractQuotaIds);


    /**
     * 根据公司合同配额id查询公司合同配额详情
     *
     * @param companyContractQuotaId 公司合同配额id
     * @return 公司合同配额详情
     */
    @ApiOperation(value = "根据公司合同配额id查询公司合同配额详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyContractQuotaId", dataType = "Long", value = "公司合同配额id", paramType = "path")
    })
    Result<CompanyContractQuotaVO> findById(Long companyContractQuotaId);


    /**
     * 查询公司合同配额
     *
     * @param companyContractQuotaQuery 公司合同配额查询参数
     * @return page
     */
    @ApiOperation(value = "查询公司合同配额")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyContractQuotaQuery", dataType = "CompanyContractQuotaQuery", value = "公司合同配额查询参数", paramType = "query")
    })
    Result<List<CompanyContractQuotaVO>> listAll(CompanyContractQuotaQuery companyContractQuotaQuery);

    /**
     * 分页查询公司合同配额
     *
     * @param companyContractQuotaQuery 公司合同配额查询参数
     * @return page
     */
    @ApiOperation(value = "分页查询公司合同配额")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyContractQuotaQuery", dataType = "CompanyContractQuotaQuery", value = "公司合同配额查询参数", paramType = "query")
    })
    Result<Page<CompanyContractQuotaVO>> page(CompanyContractQuotaQuery companyContractQuotaQuery);


}

